fix(properties): correct topic property name in kafka_batch_max_bytes reference by Feediver1 · Pull Request #1775 · redpanda-data/docs

Feediver1 · 2026-07-02T15:49:07Z

Why

The kafka_batch_max_bytes cluster property referenced the topic-level message-size property by the wrong name — message.max.bytes (the Kafka broker-config name) — in two places: its description and its Related topics link. The correct topic property is max.message.bytes (defined in topic-properties.adoc).

This is the self-managed counterpart to the same error fixed in cloud-docs prose (redpanda-data/cloud-docs#627).

What

docs-data/property-overrides.json — corrected both message.max.bytes → max.message.bytes in the kafka_batch_max_bytes override (description + related_topics). This is the source of truth.
modules/reference/partials/properties/cluster-properties.adoc and modules/reference/attachments/redpanda-properties-v26.1.10.json — regenerated via doc-tools generate property-docs --tag v26.1.10 --generate-partials (cloud-support tags intact), so the generated artifacts reflect the override.

Diff is limited to this one property: 3 files, 6 lines, all the message.max.bytes → max.message.bytes correction.

Note for reviewers

Regenerating at v26.1.10 surfaced one unrelated drift I deliberately excluded from this PR: topic_memory_per_partition's default rendered as the raw constant DEFAULT_TOPIC_MEMORY_PER_PARTITION instead of the resolved 200 KiB (204800) currently on main. I reverted that line to match main so this PR stays scoped. Worth a separate look — a future auto-docs regen may reintroduce it (looks like a default-resolution regression in the property extractor).

🤖 Generated with Claude Code

… reference The kafka_batch_max_bytes cluster property referenced the topic-level message size property as `message.max.bytes` (the Kafka broker-config name) in both its description and its Related topics link. The correct topic property is `max.message.bytes` (see topic-properties.adoc). Corrected the override in docs-data/property-overrides.json and regenerated the property partial + JSON attachment at tag v26.1.10 with cloud-support intact. Self-managed counterpart to the same error fixed in cloud-docs prose (redpanda-data/cloud-docs#627). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

netlify · 2026-07-02T15:49:14Z

✅ Deploy Preview for redpanda-docs-preview ready!

Name	Link
🔨 Latest commit	`8611bcd`
🔍 Latest deploy log	https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a4fd51cdedeb0000851b65a
😎 Deploy Preview	https://deploy-preview-1775--redpanda-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

coderabbitai · 2026-07-02T15:52:06Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d23c4b18-082a-47f9-9870-526cb366a7f6

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

📝 Walkthrough

Walkthrough

This change updates documentation references for the kafka_batch_max_bytes property, replacing mentions of the topic property message.max.bytes with the corrected max.message.bytes in three files: property-overrides.json, the generated redpanda-properties-v26.1.10.json, and cluster-properties.adoc. Both description text and related-topics links were updated consistently across these files.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Compact Metadata

Related issues: None provided
Related PRs: None provided
Suggested labels: documentation
Suggested reviewers: None provided

Poem:
A rabbit hopped through docs so neat,
Fixing bytes that didn't quite meet.
"max.message" now takes its place,
Where "message.max" once left a trace.
Three files aligned, the fix complete! 🐰

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description explains the change well, but it does not follow the required template sections or include the Jira link, review deadline, previews, and checks.	Add the template sections: Description with Jira ticket, Review deadline, Page previews, and Checks with the appropriate checkbox selected.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly describes the main change: correcting the kafka_batch_max_bytes topic property reference.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch fix-kafka-batch-max-bytes-topic-prop-name

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 1

♻️ Duplicate comments (1)

modules/reference/attachments/redpanda-properties-v26.1.10.json (1)
7820-7820: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Same missing-anchor issue propagated from the override source.

This generated file mirrors the docs-data/property-overrides.json entry, including the xref that lacks the #max-message-bytes anchor. Fix at the source (property-overrides.json) and regenerate; no separate fix needed here.

Also applies to: 7829-7829
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@modules/reference/attachments/redpanda-properties-v26.1.10.json` at line
7820, The missing-anchor xref is inherited from the override source, so fix the
`property-overrides.json` entry that feeds this generated property description
rather than editing `redpanda-properties-v26.1.10.json` directly. Update the
`max.message.bytes` reference in the relevant override record to include the
`#max-message-bytes` anchor, then regenerate the docs so the generated output
picks up the corrected link. This applies to the override entry used by the
mirrored property descriptions, including the one that produced the
`description` field here.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs-data/property-overrides.json`:
- Around line 1207-1210: The xref for max.message.bytes in both related_topics
and description is missing the anchor, so it points to the top of
topic-properties.adoc instead of the property section. Update the references in
property-overrides.json to match the existing pattern used elsewhere in this
file by adding the max-message-bytes anchor to the xref. Use the related_topics
entry and the description text as the places to fix, keeping the same reference
target format as the other max.message.bytes links.

---

Duplicate comments:
In `@modules/reference/attachments/redpanda-properties-v26.1.10.json`:
- Line 7820: The missing-anchor xref is inherited from the override source, so
fix the `property-overrides.json` entry that feeds this generated property
description rather than editing `redpanda-properties-v26.1.10.json` directly.
Update the `max.message.bytes` reference in the relevant override record to
include the `#max-message-bytes` anchor, then regenerate the docs so the
generated output picks up the corrected link. This applies to the override entry
used by the mirrored property descriptions, including the one that produced the
`description` field here.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b130627c-8d4e-49ec-81be-a25967cc0635

📥 Commits

Reviewing files that changed from the base of the PR and between 1beb0a1 and 11a993c.

📒 Files selected for processing (3)

docs-data/property-overrides.json
modules/reference/attachments/redpanda-properties-v26.1.10.json
modules/reference/partials/properties/cluster-properties.adoc

micheleRP

lgtm

Feediver1 · 2026-07-09T17:05:02Z

@copilot resolve the merge conflicts in this pull request

Copilot · 2026-07-09T17:06:37Z

@copilot resolve the merge conflicts in this pull request

Merged main into this branch — the merge resolved cleanly (no conflicts). The kafka_batch_max_bytes fix is preserved alongside the auto-docs v26.1.12 update from main.

Feediver1 requested a review from a team as a code owner July 2, 2026 15:49

Feediver1 requested a review from micheleRP July 2, 2026 15:50

coderabbitai Bot reviewed Jul 2, 2026

View reviewed changes

Comment thread docs-data/property-overrides.json

micheleRP approved these changes Jul 2, 2026

View reviewed changes

Copilot started work on behalf of Feediver1 July 9, 2026 17:05 View session

merge: sync with main (auto-docs v26.1.12 update)

8611bcd

Copilot finished work on behalf of Feediver1 July 9, 2026 17:06

Feediver1 merged commit 103a560 into main Jul 10, 2026
5 checks passed

Feediver1 deleted the fix-kafka-batch-max-bytes-topic-prop-name branch July 10, 2026 16:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(properties): correct topic property name in kafka_batch_max_bytes reference#1775

fix(properties): correct topic property name in kafka_batch_max_bytes reference#1775
Feediver1 merged 2 commits into
mainfrom
fix-kafka-batch-max-bytes-topic-prop-name

Feediver1 commented Jul 2, 2026

Uh oh!

netlify Bot commented Jul 2, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jul 2, 2026 •

edited

Loading

Review skipped

Walkthrough

Compact Metadata

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

micheleRP left a comment

Uh oh!

Feediver1 commented Jul 9, 2026

Uh oh!

Copilot AI commented Jul 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Feediver1 commented Jul 2, 2026

Why

What

Note for reviewers

Uh oh!

netlify Bot commented Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for redpanda-docs-preview ready!

Uh oh!

coderabbitai Bot commented Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Compact Metadata

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

micheleRP left a comment

Choose a reason for hiding this comment

Uh oh!

Feediver1 commented Jul 9, 2026

Uh oh!

Copilot AI commented Jul 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

netlify Bot commented Jul 2, 2026 •

edited

Loading

coderabbitai Bot commented Jul 2, 2026 •

edited

Loading